Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Marigold snapshot removal #12

Closed
wants to merge 4 commits into from
Closed

Marigold snapshot removal #12

wants to merge 4 commits into from

Conversation

craigbuckler
Copy link
Contributor

Removed Marigold snapshot JSON from charts/tezos/values.yaml. Was:

snapshot_source: https://snapshots.tezos.marigold.dev/api/tezos-snapshots.json

Now:

snapshot_source: null

By default, it will no longer attempt to download a snapshot and the chain will sync from scratch. However, users can still set any JSON URL (if available) and this update shouldn't break existing configurations.

To use a specific snapshot URL such as one from tzinit.org, users can set one of:

full_snapshot_url: null # e.g. https://snapshots.eu.tzinit.org/mainnet/full
rolling_snapshot_url: null # e.g. https://snapshots.us.tzinit.org/mainnet/rolling

This also allows them to use their closest region. This seems preferable to adding further options or automatically downloading a snapshot without the user requesting it, but I recommend a review to ensure there aren't unintended consequences.

Note that the test/charts/*expect.yaml files are sensitive to whitespace changes in charts/tezos/values.yaml.

Other minor updates:

  • Paris update to mkchain/tqchain/mkchain.py
  • corrected spelling mistakes in charts/snapshotEngine/README.md

@nicolasochem
Copy link
Contributor

nicolasochem commented May 9, 2024

Hi Craig,

By default, it will no longer attempt to download a snapshot and the chain will sync from scratch. However, users can still set any JSON URL (if available) and this update shouldn't break existing configurations.

with xtz shots and marigold down, there is no longer any snapshot service compatible with this metadata. It would be nice if tznit could generate such a json to restore the previous functionality. Otherwise, I guess the json parsing logic in utils/config_generator.py can also be deleted.

This also allows them to use their closest region.

If metadata schema was updated to contain a region field, this could be automated as an extension of the existing python metadata handling code. This would be cool, but of course there has to be a need.

corrected spelling mistakes in charts/snapshotEngine/README.md

actually, we might want to delete the whole snapshotEngine chart. Unless you are planning to migrate tzinit snapshots to k8s, this is dead code.

Paris update to mkchain/tqchain/mkchain.py

Thanks. This could be its own PR? There are a few more things to do:

See examples:

Nairobi update:
39ef10c

Oxford update (actually blended in with a lot of unrelated changes):
d34dee0

Most notably, the parameters.yaml file needs to be updated with a set of parameters that works with paris. You can test by running mkchain with no parameters, and the resulting chart values should start a private chain running Paris protocol.

@craigbuckler
Copy link
Contributor Author

Thanks @nicolasochem - appreciate the feedback.

Marigold appears to be running for the moment, so we probably shouldn't remove the JSON functionality just yet. I've been considering possibilities and will (probably) add a new metadata option to select a tzinit.org region when a specific URL or JSON source is not provided. It'll therefore attempt to get a snapshot like it does now.

Good point about mkchain - I'll separate into a new PR.

@craigbuckler craigbuckler deleted the marigold-removal branch July 25, 2024 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants